Skip to main content
PUT
Update contract clause

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json

Contract clause update payload.

name
string

Name of the contract clause, displayed in the contract library.

Minimum string length: 1
Example:

"Termination clause"

text
string

Default text of the clause, used when no translation exists for the customer language. Plain text, line breaks are preserved.

Minimum string length: 1
Example:

"Either party may terminate the agreement with a 30-day written notice."

translations
object

Translations of the clause, keyed by language code. Replaces all existing translations: omitted languages are removed.

Example:
invoicing_entity_ids
string[]

IDs of the invoicing entities for which the clause is available when building a quote.

Example:

Response

Contract clause updated.

id
string
required

Contract clause ID.

Example:

"ccl_QalW2vTAdkR6IY"

name
string
required

Name of the contract clause, displayed in the contract library.

Example:

"Termination clause"

text
string
required

Default text of the clause, used when no translation exists for the customer language. Plain text, line breaks are preserved.

Example:

"Either party may terminate the agreement with a 30-day written notice."

translations
object
required

Translations of the clause, keyed by language code. The translation matching the customer language is used instead of text.

Example:
invoicing_entity_ids
string[]
required

IDs of the invoicing entities for which the clause is available when building a quote.

Example:
created_at
string<date-time>
required

Contract clause creation date. UTC date time string in the ISO 8601 format.

Example:

"2024-06-03T12:32:22Z"

updated_at
string<date-time>
required

Contract clause last edition date. UTC date time string in the ISO 8601 format.

Example:

"2024-06-07T18:13:25Z"